************
INTRODUCTION
************

This file describes how to set up and use the Python wrapper code with Melissa DATA's Phone Object.


*************
PREREQUISITES
*************

To make use of the Phone Object Python wrapper you will need:

* An installation of a Python. This Wrapper tested with Python 2.5.2.

* The Melissa DATA Phone Object library and data files installed.
  These files are installed automatically if you run setup.exe. By default, the Phone Object 
  Library (mdPhone.dll) is installed in:
	C:\Program Files\Melissa DATA\DQT\PhoneObj\dll_32bit
* 64bit version available in C:\Program Files\Melissa DATA\DQT\PhoneObj\dll_64bit

  and the Phone Object data files in:
	C:\Program Files\Melissa DATA\DQT\Data

You will need to know the location of these items in order to install and run the Python wrapper.


**********************
Wrapper compatibility
**********************

If the provided pre-compiled wrappers are not compatible with your environment, the necessary files for compilation can be found in the 'interfaces' folder of the object's main directory.



***********
Demo Mode
***********

Phone Object will function in Demo mode without a valid license string. In Demo mode, only Nevada Phones
will be validated. Please contact your sales representative at 1-800-MELISSA ext. 3 for a valid license.


*************
Installation
*************

Copy the entire folder that contains this readme.txt into a local directory on your computer.


*****
Setup
*****

You will need to allow _mdPhonePythonWrapper.pyd to find mdPhone.dll. You can do this by:

	1. Adding the directory containing mdPhone to your PATH environment variable. 
	   ex: set PATH=%PATH%;C:\Program Files\Melissa DATA\DQT\PhoneObj\dll_32bit
* 64bit version available in C:\Program Files\Melissa DATA\DQT\phoneObj\dll_64bit

	or

	2. Copy mdPhone.dll into the directory with _mdPhonePythonWrapper.pyd.



**************************
Setting up the Sample Code
**************************

Open PhoneSample.py for editing. You can set the license string:

	License = "Demo"

and also the path to the Phone Object Data Files:

	DataPath = r"C:\Program Files\Melissa Data\DQT\Data"


***********************
Running the Sample Code
***********************

Navigate to the directory containing the python wrapper using command line and type:

	python PhoneSample.py

*******
Updates
*******

The files generated/included in this wrapper do not need to be changed for DQ Suite updates unless there is a method signature change in the object. If a new method is added, you will need to rebuild the wrapper to use the new method. 

****
Note
****

Here are some general solutions if you run into problems:

Q. I get an error saying "can't find mdPhone.dll."
A. This means that _mdPhonePythonWrapper.pyd cannot link to mdPhone.dll. Please follow the steps in
the Setup section above.

Q. I get an error saying "cannot import module mdPhonePythonWrapper"
A. The current _mdPhonePythonWrapper.pyd was compiled using Python 2.5.2. You might be using another version of
Python. You will need another version of _mdPhonePythonWrapper.pyd that uses the version of Python on your system. 
Please look in the "Source" folder and read the readme for instructions. 


COPYRIGHT NOTICE

(C) 2014 Melissa Data Corporation. All rights reserved.
